<!DOCTYPE html>
<html>
<head>
	<meta charset="utf-8">

	<title>ASNetworkImageNode Class Reference</title>

	<link rel="stylesheet" href="../css/style.css">
	<meta name="viewport" content="initial-scale=1, maximum-scale=1.4">
	<meta name="generator" content="appledoc 2.2.1 (build 1334)">
</head>
<body class="appledoc">
	<header>
		<div class="container" class="hide-in-xcode">
			
			<h1 id="library-title">
				<a href="../index.html">  </a>
			</h1>

			<p id="developer-home">
				<a href="../index.html">AsyncDisplayKit</a>
			</p>
			
		</div>
	</header>

	<aside>
		<div class="container">
			<nav>
				<ul id="header-buttons" role="toolbar">
					<li><a href="../index.html">Index</a></li>
<li><a href="../hierarchy.html">Hierarchy</a></li>

					<li id="on-this-page" role="navigation">
						<label>
							On This Page

							<div class="chevron">
								<div class="chevy chevron-left"></div>
								<div class="chevy chevron-right"></div>
							</div>

							<select id="jump-to">
	<option value="top">Jump To&#133;</option>
	
	<option value="overview">Overview</option>
	

	
	
	<option value="tasks">Tasks</option>
	
	

	
	
	<optgroup label="Properties">
		
		<option value="//api/name/URL">URL</option>
		
		<option value="//api/name/currentImageQuality">currentImageQuality</option>
		
		<option value="//api/name/defaultImage">defaultImage</option>
		
		<option value="//api/name/delegate">delegate</option>
		
		<option value="//api/name/renderedImageQuality">renderedImageQuality</option>
		
		<option value="//api/name/shouldCacheImage">shouldCacheImage</option>
		
		<option value="//api/name/shouldRenderProgressImages">shouldRenderProgressImages</option>
		
	</optgroup>
	

	

	
	<optgroup label="Instance Methods">
		
		<option value="//api/name/init">- init</option>
		
		<option value="//api/name/initWithCache:downloader:">- initWithCache:downloader:</option>
		
		<option value="//api/name/setURL:resetToDefault:">- setURL:resetToDefault:</option>
		
	</optgroup>
	
	
</select>
						</label>
					</li>
				</ul>
			</nav>
		</div>
	</aside>

	<article>
		<div id="overview_contents" class="container">
			<div id="content">
				<main role="main">
					<h1 class="title">ASNetworkImageNode Class Reference</h1>

					
					<div class="section section-specification"><table cellspacing="0"><tbody>
						<tr>
	<th>Inherits from</th>
	<td><a href="../Classes/ASImageNode.html">ASImageNode</a> : <a href="../Classes/ASControlNode.html">ASControlNode</a> : <a href="../Classes/ASDisplayNode.html">ASDisplayNode</a> : ASDealloc2MainObject</td>
</tr><tr>
	<th>Declared in</th>
	<td>ASNetworkImageNode.h</td>
</tr>
						</tbody></table></div>
					

                    
					
					<div class="section section-overview">
						<a title="Overview" name="overview"></a>
						<h2 class="subtitle subtitle-overview">Overview</h2>
						<p>ASNetworkImageNode is a simple image node that can download and display an image from the network, with support for a
placeholder image (<a href="#//api/name/defaultImage">defaultImage</a>).  The currently-displayed image is always available in the inherited ASImageNode
<image> property.</p>
					</div>
					
					

					
					
					<div class="section section-tasks">
						<a title="Tasks" name="tasks"></a>
						

						
						

						<div class="task-list">
							<div class="section-method">
	<a name="//api/name/initWithCache:downloader:" title="initWithCache:downloader:"></a>
	<h3 class="method-title"><code><a href="#//api/name/initWithCache:downloader:">&ndash;&nbsp;initWithCache:downloader:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>The designated initializer.  Cache and Downloader are WEAK references.</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (instancetype)initWithCache:(nullable id&lt;ASImageCacheProtocol&gt;)<em>cache</em> downloader:(id&lt;ASImageDownloaderProtocol&gt;)<em>downloader</em></code></div>

		    
			
			<div class="method-subsection arguments-section parameters">
				<h4 class="method-subtitle parameter-title">Parameters</h4>
				<table class="argument-def parameter-def">
				
					<tr>
						<th scope="row" class="argument-name"><code>cache</code></th>
						<td><p>The object that implements a cache of images for the image node.  Weak reference.</p></td>
					</tr>
				
					<tr>
						<th scope="row" class="argument-name"><code>downloader</code></th>
						<td><p>The object that implements image downloading for the image node.  Must not be nil.  Weak reference.</p></td>
					</tr>
				
				</table>
			</div>
			

			
			<div class="method-subsection return">
				<h4 class="method-subtitle parameter-title">Return Value</h4>
				<p>An initialized ASNetworkImageNode.</p>
			</div>
			

			

			
			<div class="method-subsection discussion-section">
				<h4 class="method-subtitle">Discussion</h4>
				<p>If <code>cache</code> is nil, the receiver will not attempt to retrieve images from a cache before downloading them.</p>
			</div>
			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">ASNetworkImageNode.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/init" title="init"></a>
	<h3 class="method-title"><code><a href="#//api/name/init">&ndash;&nbsp;init</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Convenience initialiser.</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (instancetype)init</code></div>

		    
			

			
			<div class="method-subsection return">
				<h4 class="method-subtitle parameter-title">Return Value</h4>
				<p>An ASNetworkImageNode configured to use the NSURLSession-powered ASBasicImageDownloader, and no extra cache.</p>
			</div>
			

			

			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">ASNetworkImageNode.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/delegate" title="delegate"></a>
	<h3 class="method-title"><code><a href="#//api/name/delegate">&nbsp;&nbsp;delegate</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>The delegate, which must conform to the <a href="../Protocols/ASNetworkImageNodeDelegate.html">ASNetworkImageNodeDelegate</a> protocol.</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>@property (nullable, nonatomic, weak, readwrite) id&lt;ASNetworkImageNodeDelegate&gt; delegate</code></div>

		    
			

			

			

			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">ASNetworkImageNode.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/defaultImage" title="defaultImage"></a>
	<h3 class="method-title"><code><a href="#//api/name/defaultImage">&nbsp;&nbsp;defaultImage</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>A placeholder image to display while the URL is loading.</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>@property (nullable, nonatomic, strong, readwrite) UIImage *defaultImage</code></div>

		    
			

			

			

			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">ASNetworkImageNode.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/URL" title="URL"></a>
	<h3 class="method-title"><code><a href="#//api/name/URL">&nbsp;&nbsp;URL</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>The URL of a new image to download and display.</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>@property (nullable, nonatomic, strong, readwrite) NSURL *URL</code></div>

		    
			

			

			

			
			<div class="method-subsection discussion-section">
				<h4 class="method-subtitle">Discussion</h4>
				<p>Changing this property will reset the displayed image to a placeholder (<a href="#//api/name/defaultImage">defaultImage</a>) while loading.</p>
			</div>
			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">ASNetworkImageNode.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/setURL:resetToDefault:" title="setURL:resetToDefault:"></a>
	<h3 class="method-title"><code><a href="#//api/name/setURL:resetToDefault:">&ndash;&nbsp;setURL:resetToDefault:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Download and display a new image.</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (void)setURL:(nullable NSURL *)<em>URL</em> resetToDefault:(BOOL)<em>reset</em></code></div>

		    
			
			<div class="method-subsection arguments-section parameters">
				<h4 class="method-subtitle parameter-title">Parameters</h4>
				<table class="argument-def parameter-def">
				
					<tr>
						<th scope="row" class="argument-name"><code>URL</code></th>
						<td><p>The URL of a new image to download and display.</p></td>
					</tr>
				
					<tr>
						<th scope="row" class="argument-name"><code>reset</code></th>
						<td><p>Whether to display a placeholder (<a href="#//api/name/defaultImage">defaultImage</a>) while loading the new image.</p></td>
					</tr>
				
				</table>
			</div>
			

			

			

			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">ASNetworkImageNode.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/shouldCacheImage" title="shouldCacheImage"></a>
	<h3 class="method-title"><code><a href="#//api/name/shouldCacheImage">&nbsp;&nbsp;shouldCacheImage</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>If <a href="#//api/name/URL">URL</a> is a local file, set this property to YES to take advantage of UIKit&rsquo;s image caching.  Defaults to YES.</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>@property (nonatomic, assign, readwrite) BOOL shouldCacheImage</code></div>

		    
			

			

			

			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">ASNetworkImageNode.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/shouldRenderProgressImages" title="shouldRenderProgressImages"></a>
	<h3 class="method-title"><code><a href="#//api/name/shouldRenderProgressImages">&nbsp;&nbsp;shouldRenderProgressImages</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>If the downloader implements progressive image rendering and this value is YES progressive renders of the
image will be displayed as the image downloads. Regardless of this properties value, progress renders will
only occur when the node is visible. Defaults to YES.</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>@property (nonatomic, assign, readwrite) BOOL shouldRenderProgressImages</code></div>

		    
			

			

			

			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">ASNetworkImageNode.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/currentImageQuality" title="currentImageQuality"></a>
	<h3 class="method-title"><code><a href="#//api/name/currentImageQuality">&nbsp;&nbsp;currentImageQuality</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>The image quality of the current image. This is a number between 0 and 1 and can be used to track
progressive progress. Calculated by dividing number of bytes / expected number of total bytes.</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>@property (nonatomic, assign, readonly) CGFloat currentImageQuality</code></div>

		    
			

			

			

			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">ASNetworkImageNode.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/renderedImageQuality" title="renderedImageQuality"></a>
	<h3 class="method-title"><code><a href="#//api/name/renderedImageQuality">&nbsp;&nbsp;renderedImageQuality</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>The image quality (value between 0 and 1) of the last image that completed displaying.</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>@property (nonatomic, assign, readonly) CGFloat renderedImageQuality</code></div>

		    
			

			

			

			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">ASNetworkImageNode.h</code></p>
			</div>
			
			
		</div>
	</div>
</div>
						</div>
						
					</div>
					
					

                    
                    
          
				</main>

				<footer>
					<div class="footer-copyright">
						
						<p class="copyright">Copyright &copy; 2016 AsyncDisplayKit. All rights reserved. Updated: 2016-11-05</p>
						
						
						<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p>
						
					</div>
				</footer>
			</div>
		</div>
	</article>

	<script src="../js/script.js"></script>
</body>
</html>